<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>EquTemper: ddhc_main.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="$relpath<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="$relpath<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>/search.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">EquTemper&#160;<span id="projectnumber">1.01</span></div>
   <div id="projectbrief">An equation editor.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<script type="text/javascript">
function hasClass(ele,cls) {
  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}

function addClass(ele,cls) {
  if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}

function removeClass(ele,cls) {
  if (hasClass(ele,cls)) {
    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
    ele.className=ele.className.replace(reg,' ');
  }
}

function toggleVisibility(linkObj) {
 var base = linkObj.getAttribute('id');
 var summary = document.getElementById(base + '-summary');
 var content = document.getElementById(base + '-content');
 var trigger = document.getElementById(base + '-trigger');
 if ( hasClass(linkObj,'closed') ) {
   summary.style.display = 'none';
   content.style.display = 'block';
   trigger.src = 'open.png';
   removeClass(linkObj,'closed');
   addClass(linkObj,'opened');
 } else if ( hasClass(linkObj,'opened') ) {
   summary.style.display = 'block';
   content.style.display = 'none';
   trigger.src = 'closed.png';
   removeClass(linkObj,'opened');
   addClass(linkObj,'closed');
 }
 return false;
}
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
      <li id="searchli">
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('ddhc__main_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">ddhc_main.h</div>  </div>
</div>
<div class="contents">
<a href="ddhc__main_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* ========================================================================= */</span>
<a name="l00002"></a>00002 <span class="comment">/* ------------------------------------------------------------------------- */</span><span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment">/*!</span>
<a name="l00004"></a>00004 <span class="comment">\file       ddhc_main.h</span>
<a name="l00005"></a>00005 <span class="comment">\date       september 2011</span>
<a name="l00006"></a>00006 <span class="comment">\author     TNick</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment">\brief      Groups all definitions related to dinamic debug helper code</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment">Copyright (c) 2011, Nicu Tofan</span>
<a name="l00012"></a>00012 <span class="comment">All rights reserved.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">Redistribution and use in source and binary forms, with or without</span>
<a name="l00015"></a>00015 <span class="comment">modification, are permitted provided that the following conditions are met:</span>
<a name="l00016"></a>00016 <span class="comment">* Redistributions of source code must retain the above copyright</span>
<a name="l00017"></a>00017 <span class="comment">notice, this list of conditions and the following disclaimer.</span>
<a name="l00018"></a>00018 <span class="comment">* Redistributions in binary form must reproduce the above copyright</span>
<a name="l00019"></a>00019 <span class="comment">notice, this list of conditions and the following disclaimer in the</span>
<a name="l00020"></a>00020 <span class="comment">documentation and/or other materials provided with the distribution.</span>
<a name="l00021"></a>00021 <span class="comment">* Neither the name of the copyright holder nor the</span>
<a name="l00022"></a>00022 <span class="comment">names of its contributors may be used to endorse or promote products</span>
<a name="l00023"></a>00023 <span class="comment">derived from this software without specific prior written permission.</span>
<a name="l00024"></a>00024 <span class="comment"></span>
<a name="l00025"></a>00025 <span class="comment">THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS &quot;AS IS&quot; AND</span>
<a name="l00026"></a>00026 <span class="comment">ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span>
<a name="l00027"></a>00027 <span class="comment">WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE</span>
<a name="l00028"></a>00028 <span class="comment">DISCLAIMED. IN NO EVENT SHALL NICU TOFAN BE LIABLE FOR ANY</span>
<a name="l00029"></a>00029 <span class="comment">DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES</span>
<a name="l00030"></a>00030 <span class="comment">(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;</span>
<a name="l00031"></a>00031 <span class="comment">LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND</span>
<a name="l00032"></a>00032 <span class="comment">ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
<a name="l00033"></a>00033 <span class="comment">(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span>
<a name="l00034"></a>00034 <span class="comment">SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">*/</span>
<a name="l00037"></a>00037 <span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/**</span>
<a name="l00039"></a>00039 <span class="comment"></span>
<a name="l00040"></a>00040 <span class="comment">\page ddhc_main_page Dynamic Debug Helper Code (DDHC)</span>
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment">The features implemented by the DDHC module are meant to help the coder</span>
<a name="l00043"></a>00043 <span class="comment">while developing the application. As such, they should only be included</span>
<a name="l00044"></a>00044 <span class="comment">in code if the application is not being builded for deployment. The single</span>
<a name="l00045"></a>00045 <span class="comment">switch that enables or disables the DDHC module is ENABLE_DDHC. It must</span>
<a name="l00046"></a>00046 <span class="comment">always be defined in the main include file for the application and includes</span>
<a name="l00047"></a>00047 <span class="comment">the features if is 1 and excludes the features otherwise, replacing them with</span>
<a name="l00048"></a>00048 <span class="comment">empty stubs.</span>
<a name="l00049"></a>00049 <span class="comment">@code</span>
<a name="l00050"></a>00050 <span class="comment">#define     ENABLE_DDHC     1   // to enable the features</span>
<a name="l00051"></a>00051 <span class="comment">#define     ENABLE_DDHC     0   // to disable the features</span>
<a name="l00052"></a>00052 <span class="comment">@endcode</span>
<a name="l00053"></a>00053 <span class="comment">To include the features only when in debug configuration, assuming that a</span>
<a name="l00054"></a>00054 <span class="comment">DEBUG macro is defined accordingly:</span>
<a name="l00055"></a>00055 <span class="comment">@code</span>
<a name="l00056"></a>00056 <span class="comment">#ifdef      DEBUG</span>
<a name="l00057"></a>00057 <span class="comment">#define     ENABLE_DDHC     1   // to enable the features</span>
<a name="l00058"></a>00058 <span class="comment">#else</span>
<a name="l00059"></a>00059 <span class="comment">#define     ENABLE_DDHC     0   // to disable the features</span>
<a name="l00060"></a>00060 <span class="comment">#endif</span>
<a name="l00061"></a>00061 <span class="comment">@endcode</span>
<a name="l00062"></a>00062 <span class="comment"></span>
<a name="l00063"></a>00063 <span class="comment">\section sec_assumptiuons   Assumptions</span>
<a name="l00064"></a>00064 <span class="comment">The application is supposed to include the ddhc_main.h file inside it&#39;s own</span>
<a name="l00065"></a>00065 <span class="comment">main.h header, after ENABLE_DDHC was defined with a proper value. The parts</span>
<a name="l00066"></a>00066 <span class="comment">of the code that make use of DDHC features must then include the main header</span>
<a name="l00067"></a>00067 <span class="comment">before any other definitions.</span>
<a name="l00068"></a>00068 <span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment">\section sec_content        Content</span>
<a name="l00070"></a>00070 <span class="comment"></span>
<a name="l00071"></a>00071 <span class="comment">\subpage sec_interface &quot;Interface&quot; page gives informations about how one</span>
<a name="l00072"></a>00072 <span class="comment">should go about using this module. \subpage debug_implementation &quot;Implementation&quot;</span>
<a name="l00073"></a>00073 <span class="comment">page gives insight in how the code that makes up DDHC module is organised and</span>
<a name="l00074"></a>00074 <span class="comment">what each part does.</span>
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment">\section sec_toodo          Todo list</span>
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment">- re-parent from inside the kid and from inside the parent</span>
<a name="l00079"></a>00079 <span class="comment">- change signal</span>
<a name="l00080"></a>00080 <span class="comment">- refresh</span>
<a name="l00081"></a>00081 <span class="comment">- contextual menu</span>
<a name="l00082"></a>00082 <span class="comment">- properties for QOBJECT</span>
<a name="l00083"></a>00083 <span class="comment">- editing the items</span>
<a name="l00084"></a>00084 <span class="comment">- smaller indent in tree</span>
<a name="l00085"></a>00085 <span class="comment">- custom property get/set</span>
<a name="l00086"></a>00086 <span class="comment"></span>
<a name="l00087"></a>00087 <span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment"></span>
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment">\page sec_interface     Interface</span>
<a name="l00091"></a>00091 <span class="comment">The user of the code makes use of following elements:</span>
<a name="l00092"></a>00092 <span class="comment">- Initialization code may look like this:</span>
<a name="l00093"></a>00093 <span class="comment">@code</span>
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment">// the code is assumed to be placed in a method belonging to a widget</span>
<a name="l00096"></a>00096 <span class="comment">#if     (ENABLE_DDHC == 1)</span>
<a name="l00097"></a>00097 <span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment">    // create a treeview and set it up the way you like</span>
<a name="l00099"></a>00099 <span class="comment">    QTreeView * tv_tree_ddhc = new QTreeView(this);</span>
<a name="l00100"></a>00100 <span class="comment">    tv_tree_ddhc-&gt;setHeaderHidden( false );</span>
<a name="l00101"></a>00101 <span class="comment">    tv_tree_ddhc-&gt;setRootIsDecorated( true );</span>
<a name="l00102"></a>00102 <span class="comment">    tv_tree_ddhc-&gt;setUniformRowHeights( true );</span>
<a name="l00103"></a>00103 <span class="comment">    tv_tree_ddhc-&gt;setMinimumWidth(350);</span>
<a name="l00104"></a>00104 <span class="comment"></span>
<a name="l00105"></a>00105 <span class="comment">    // create the model or get already created instance; assign model to view</span>
<a name="l00106"></a>00106 <span class="comment">    DDHC::Model * ddhc_mdl =  DDHC::Model::mInst();</span>
<a name="l00107"></a>00107 <span class="comment">    tv_tree_ddhc-&gt;setModel(ddhc_mdl);</span>
<a name="l00108"></a>00108 <span class="comment"></span>
<a name="l00109"></a>00109 <span class="comment">    // finnaly insert the widget</span>
<a name="l00110"></a>00110 <span class="comment">    ui-&gt;centralwidget-&gt;layout()-&gt;addWidget(tv_tree_ddhc);</span>
<a name="l00111"></a>00111 <span class="comment">    tv_tree_ddhc-&gt;expandAll();</span>
<a name="l00112"></a>00112 <span class="comment"></span>
<a name="l00113"></a>00113 <span class="comment">#endif</span>
<a name="l00114"></a>00114 <span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment"></span>
<a name="l00116"></a>00116 <span class="comment">@endcode</span>
<a name="l00117"></a>00117 <span class="comment"></span>
<a name="l00118"></a>00118 <span class="comment"></span>
<a name="l00119"></a>00119 <span class="comment">- DDHC_INHERIT shall be used in the declaration of the class. Current</span>
<a name="l00120"></a>00120 <span class="comment">implementation hides an abstract class that is inherited</span>
<a name="l00121"></a>00121 <span class="comment">only in debug mode</span>
<a name="l00122"></a>00122 <span class="comment">@code</span>
<a name="l00123"></a>00123 <span class="comment">// file: SomeClass1.h</span>
<a name="l00124"></a>00124 <span class="comment"></span>
<a name="l00125"></a>00125 <span class="comment">class   SomeClass1  : public BaseClass, public BaseClass2,  DDHC_INHERIT    {</span>
<a name="l00126"></a>00126 <span class="comment">    SomeClass1();</span>
<a name="l00127"></a>00127 <span class="comment">    ~SomeClass1();</span>
<a name="l00128"></a>00128 <span class="comment">};</span>
<a name="l00129"></a>00129 <span class="comment"></span>
<a name="l00130"></a>00130 <span class="comment"></span>
<a name="l00131"></a>00131 <span class="comment">// file: SomeClass2.h</span>
<a name="l00132"></a>00132 <span class="comment"></span>
<a name="l00133"></a>00133 <span class="comment">class   SomeClass2  : DDHC_INHERIT  {</span>
<a name="l00134"></a>00134 <span class="comment">    SomeClass2();</span>
<a name="l00135"></a>00135 <span class="comment">    virtual ~SomeClass2();</span>
<a name="l00136"></a>00136 <span class="comment">};</span>
<a name="l00137"></a>00137 <span class="comment">@endcode</span>
<a name="l00138"></a>00138 <span class="comment"></span>
<a name="l00139"></a>00139 <span class="comment">- inside the body of the class the DDHC_CLASS macro shall be used, preferably</span>
<a name="l00140"></a>00140 <span class="comment">as the first line; otherwise, be aware that it modifies the access descriptors,</span>
<a name="l00141"></a>00141 <span class="comment">leaving the private one active. This will insert required elements inside</span>
<a name="l00142"></a>00142 <span class="comment">class body.</span>
<a name="l00143"></a>00143 <span class="comment">@code</span>
<a name="l00144"></a>00144 <span class="comment">// file: SomeClass1.h</span>
<a name="l00145"></a>00145 <span class="comment"></span>
<a name="l00146"></a>00146 <span class="comment">class   SomeClass1  : DDHC_INHERIT  {</span>
<a name="l00147"></a>00147 <span class="comment">    DDHC_CLASS</span>
<a name="l00148"></a>00148 <span class="comment"></span>
<a name="l00149"></a>00149 <span class="comment">    SomeClass1();</span>
<a name="l00150"></a>00150 <span class="comment">    virtual ~SomeClass1();</span>
<a name="l00151"></a>00151 <span class="comment">};</span>
<a name="l00152"></a>00152 <span class="comment">@endcode</span>
<a name="l00153"></a>00153 <span class="comment"></span>
<a name="l00154"></a>00154 <span class="comment">- because &quot;the results of calling (directly or indirectly) a pure</span>
<a name="l00155"></a>00155 <span class="comment">virtual function from its constructor are undefined&quot; (see</span>
<a name="l00156"></a>00156 <span class="comment">&lt;a href=&quot;http://publib.boulder.ibm.com/infocenter/comphelp/v8v101/index.jsp?topic=%2Fcom.ibm.xlcpp8a.doc%2Flanguage%2Fref%2Fcplr142.htm&quot;&gt;</span>
<a name="l00157"></a>00157 <span class="comment">reference page&lt;/a&gt;) DDHC_CONSTRUCT shall be used inside the constructors</span>
<a name="l00158"></a>00158 <span class="comment">or the initialization function used by the constructors. No matter what</span>
<a name="l00159"></a>00159 <span class="comment">implementation is choosen, it should appear only once for a class instance</span>
<a name="l00160"></a>00160 <span class="comment">in the flow of code.</span>
<a name="l00161"></a>00161 <span class="comment">@code</span>
<a name="l00162"></a>00162 <span class="comment">// file: SomeClass1.cc</span>
<a name="l00163"></a>00163 <span class="comment"></span>
<a name="l00164"></a>00164 <span class="comment">SomeClass1::SomeClass1()    {</span>
<a name="l00165"></a>00165 <span class="comment">    DDHC_CONSTRUCT;</span>
<a name="l00166"></a>00166 <span class="comment">    // .. some other stuff</span>
<a name="l00167"></a>00167 <span class="comment">}</span>
<a name="l00168"></a>00168 <span class="comment">@endcode</span>
<a name="l00169"></a>00169 <span class="comment">or</span>
<a name="l00170"></a>00170 <span class="comment">@code</span>
<a name="l00171"></a>00171 <span class="comment">// file: SomeClass1.cc</span>
<a name="l00172"></a>00172 <span class="comment"></span>
<a name="l00173"></a>00173 <span class="comment"></span>
<a name="l00174"></a>00174 <span class="comment">// initialization function used by all constructors</span>
<a name="l00175"></a>00175 <span class="comment">void    init    (void)      {</span>
<a name="l00176"></a>00176 <span class="comment">    DDHC_CONSTRUCT;</span>
<a name="l00177"></a>00177 <span class="comment">    // .. some other stuff</span>
<a name="l00178"></a>00178 <span class="comment">}</span>
<a name="l00179"></a>00179 <span class="comment"></span>
<a name="l00180"></a>00180 <span class="comment">SomeClass1::SomeClass1 ()   {</span>
<a name="l00181"></a>00181 <span class="comment">    init();</span>
<a name="l00182"></a>00182 <span class="comment">    // .. some other stuff</span>
<a name="l00183"></a>00183 <span class="comment">}</span>
<a name="l00184"></a>00184 <span class="comment"></span>
<a name="l00185"></a>00185 <span class="comment">SomeClass1::SomeClass1 ( int i )    {</span>
<a name="l00186"></a>00186 <span class="comment">    init();</span>
<a name="l00187"></a>00187 <span class="comment">    // .. some other stuff</span>
<a name="l00188"></a>00188 <span class="comment">}</span>
<a name="l00189"></a>00189 <span class="comment"></span>
<a name="l00190"></a>00190 <span class="comment">SomeClass1::SomeClass1 ( double i ) {</span>
<a name="l00191"></a>00191 <span class="comment">    init();</span>
<a name="l00192"></a>00192 <span class="comment">    // .. some other stuff</span>
<a name="l00193"></a>00193 <span class="comment">}</span>
<a name="l00194"></a>00194 <span class="comment"></span>
<a name="l00195"></a>00195 <span class="comment">@endcode</span>
<a name="l00196"></a>00196 <span class="comment"></span>
<a name="l00197"></a>00197 <span class="comment">- DDHC uses static variables for some of the data it defines; to make this</span>
<a name="l00198"></a>00198 <span class="comment">work, a DDHC_CONTENT macro for each class must be used inside a source file.</span>
<a name="l00199"></a>00199 <span class="comment">@code</span>
<a name="l00200"></a>00200 <span class="comment">// file: SomeClass1.cc</span>
<a name="l00201"></a>00201 <span class="comment"></span>
<a name="l00202"></a>00202 <span class="comment"></span>
<a name="l00203"></a>00203 <span class="comment">#include    &quot;main.h&quot;</span>
<a name="l00204"></a>00204 <span class="comment"></span>
<a name="l00205"></a>00205 <span class="comment">DDHC_CONTENT(SomeClass1);</span>
<a name="l00206"></a>00206 <span class="comment"></span>
<a name="l00207"></a>00207 <span class="comment">SomeClass1::SomeClass1()    {</span>
<a name="l00208"></a>00208 <span class="comment">    DDHC_CONSTRUCT;</span>
<a name="l00209"></a>00209 <span class="comment">    // .. some other stuff</span>
<a name="l00210"></a>00210 <span class="comment">}</span>
<a name="l00211"></a>00211 <span class="comment">@endcode</span>
<a name="l00212"></a>00212 <span class="comment"></span>
<a name="l00213"></a>00213 <span class="comment">- DDHC_VARIABLE adds a variable in the tree for a class; it has to be used</span>
<a name="l00214"></a>00214 <span class="comment">just after DDHC_CONSTRUCT (the execution shall pass only only once per instance)</span>
<a name="l00215"></a>00215 <span class="comment">The variable that is to be viewed must be a valid source for QVariant.</span>
<a name="l00216"></a>00216 <span class="comment">@code</span>
<a name="l00217"></a>00217 <span class="comment">// file: SomeClass1.h</span>
<a name="l00218"></a>00218 <span class="comment"></span>
<a name="l00219"></a>00219 <span class="comment"></span>
<a name="l00220"></a>00220 <span class="comment">class   SomeClass1  : DDHC_SINGLE_INHERIT   {</span>
<a name="l00221"></a>00221 <span class="comment">    DDHC_CLASS</span>
<a name="l00222"></a>00222 <span class="comment"></span>
<a name="l00223"></a>00223 <span class="comment">    int i_counter;</span>
<a name="l00224"></a>00224 <span class="comment"></span>
<a name="l00225"></a>00225 <span class="comment">    SomeClass1();</span>
<a name="l00226"></a>00226 <span class="comment">    virtual ~SomeClass1();</span>
<a name="l00227"></a>00227 <span class="comment">};</span>
<a name="l00228"></a>00228 <span class="comment"></span>
<a name="l00229"></a>00229 <span class="comment"></span>
<a name="l00230"></a>00230 <span class="comment">// file: SomeClass1.cc</span>
<a name="l00231"></a>00231 <span class="comment"></span>
<a name="l00232"></a>00232 <span class="comment"> SomeClass1::SomeClass1()   {</span>
<a name="l00233"></a>00233 <span class="comment">  DDHC_CONSTRUCT;</span>
<a name="l00234"></a>00234 <span class="comment">  DDHC_VARIABLE(i_counter);</span>
<a name="l00235"></a>00235 <span class="comment">  // .. some other stuff</span>
<a name="l00236"></a>00236 <span class="comment"> }</span>
<a name="l00237"></a>00237 <span class="comment"></span>
<a name="l00238"></a>00238 <span class="comment">@endcode</span>
<a name="l00239"></a>00239 <span class="comment"></span>
<a name="l00240"></a>00240 <span class="comment">- DDHC_NODE adds a class rooted inside this one; the class may be embedded</span>
<a name="l00241"></a>00241 <span class="comment">or not;</span>
<a name="l00242"></a>00242 <span class="comment">@code</span>
<a name="l00243"></a>00243 <span class="comment">// file: SomeClass1.h</span>
<a name="l00244"></a>00244 <span class="comment"></span>
<a name="l00245"></a>00245 <span class="comment"></span>
<a name="l00246"></a>00246 <span class="comment">class   SomeClass1  : DDHC_SINGLE_INHERIT   {</span>
<a name="l00247"></a>00247 <span class="comment">    DDHC_CLASS</span>
<a name="l00248"></a>00248 <span class="comment"></span>
<a name="l00249"></a>00249 <span class="comment"></span>
<a name="l00250"></a>00250 <span class="comment">    int i_counter;</span>
<a name="l00251"></a>00251 <span class="comment">    SomeClass2      cl_inst;</span>
<a name="l00252"></a>00252 <span class="comment">    SomeClass2 *    cl_another_inst;</span>
<a name="l00253"></a>00253 <span class="comment"></span>
<a name="l00254"></a>00254 <span class="comment">    SomeClass1();</span>
<a name="l00255"></a>00255 <span class="comment">    virtual ~SomeClass1();</span>
<a name="l00256"></a>00256 <span class="comment"></span>
<a name="l00257"></a>00257 <span class="comment">};</span>
<a name="l00258"></a>00258 <span class="comment"></span>
<a name="l00259"></a>00259 <span class="comment"></span>
<a name="l00260"></a>00260 <span class="comment">// file: SomeClass1.cc</span>
<a name="l00261"></a>00261 <span class="comment"></span>
<a name="l00262"></a>00262 <span class="comment"></span>
<a name="l00263"></a>00263 <span class="comment"> SomeClass1::SomeClass1()   {</span>
<a name="l00264"></a>00264 <span class="comment">  DDHC_CONSTRUCT;</span>
<a name="l00265"></a>00265 <span class="comment">  DDHC_VARIABLE(i_counter);</span>
<a name="l00266"></a>00266 <span class="comment">  DDHC_NODE(&amp;cl_inst);</span>
<a name="l00267"></a>00267 <span class="comment">  DDHC_NODE(&amp;cl_another_inst);</span>
<a name="l00268"></a>00268 <span class="comment">  // .. some other stuff</span>
<a name="l00269"></a>00269 <span class="comment"> }</span>
<a name="l00270"></a>00270 <span class="comment"></span>
<a name="l00271"></a>00271 <span class="comment">@endcode</span>
<a name="l00272"></a>00272 <span class="comment"></span>
<a name="l00273"></a>00273 <span class="comment"></span>
<a name="l00274"></a>00274 <span class="comment"></span>
<a name="l00275"></a>00275 <span class="comment"></span>
<a name="l00276"></a>00276 <span class="comment">\page debug_implementation  Implementation</span>
<a name="l00277"></a>00277 <span class="comment"></span>
<a name="l00278"></a>00278 <span class="comment">The goal of the module is to present the content of the application in a</span>
<a name="l00279"></a>00279 <span class="comment">standard way, ready to be displayed by various widgets that understand</span>
<a name="l00280"></a>00280 <span class="comment">&lt;a href=&quot;http://doc.qt.nokia.com/latest/model-view-programming.html&quot;&gt;the</span>
<a name="l00281"></a>00281 <span class="comment">model/view&lt;/a&gt; concept from &lt;a href=&quot;https://qt.nokia.com/products/&quot;&gt;Qt&lt;/a&gt;.</span>
<a name="l00282"></a>00282 <span class="comment"></span>
<a name="l00283"></a>00283 <span class="comment">The execution goes like this: the application initialises itself</span>
<a name="l00284"></a>00284 <span class="comment">by creating an widget capable of displayng the model and calls</span>
<a name="l00285"></a>00285 <span class="comment">DDHC::Model::mInst() (that will create a new instance of the model if</span>
<a name="l00286"></a>00286 <span class="comment">none exists). For each class that needs to be tracked the macros must be in</span>
<a name="l00287"></a>00287 <span class="comment">place as explained in \ref sec_interface &quot;Interface section&quot;. When a class</span>
<a name="l00288"></a>00288 <span class="comment">instance is created it calls DDHC::Ghost::_ddhc_init() that inserts</span>
<a name="l00289"></a>00289 <span class="comment">the instance in the classes chain and as top level in tree. If the instance</span>
<a name="l00290"></a>00290 <span class="comment">has a parent, then it is free to reparent the instance to itself. When variables</span>
<a name="l00291"></a>00291 <span class="comment">are added, they are placed as kids of the two associated items.</span>
<a name="l00292"></a>00292 <span class="comment"></span>
<a name="l00293"></a>00293 <span class="comment">\section sec_model The model</span>
<a name="l00294"></a>00294 <span class="comment">To achieve specified goal a class inheriting from</span>
<a name="l00295"></a>00295 <span class="comment">&lt;a href=&quot;http://doc.qt.nokia.com/latest/qabstractitemmodel.html&quot;&gt;</span>
<a name="l00296"></a>00296 <span class="comment">QAbstractItemModel&lt;/a&gt; needs to be defined. It is the DDHC::Model that,</span>
<a name="l00297"></a>00297 <span class="comment">beside having the role to expose a standard interface usable by widgets</span>
<a name="l00298"></a>00298 <span class="comment">also acts as central class.</span>
<a name="l00299"></a>00299 <span class="comment"></span>
<a name="l00300"></a>00300 <span class="comment">Only one instance of this class is needed and allowed. External world</span>
<a name="l00301"></a>00301 <span class="comment">calls DDHC::Model::mInst() and this either constructs one or returns the</span>
<a name="l00302"></a>00302 <span class="comment">existing one.</span>
<a name="l00303"></a>00303 <span class="comment"></span>
<a name="l00304"></a>00304 <span class="comment">The class embedds a DDHC::Tree class and a DDHC::Classes, first handling the</span>
<a name="l00305"></a>00305 <span class="comment">hierarchical tree fo items while second groups all classes and all</span>
<a name="l00306"></a>00306 <span class="comment">instances created from each class.</span>
<a name="l00307"></a>00307 <span class="comment"></span>
<a name="l00308"></a>00308 <span class="comment">To support the management of the items, the class provides functions to</span>
<a name="l00309"></a>00309 <span class="comment">add elements to the model, both in list and in the tree.</span>
<a name="l00310"></a>00310 <span class="comment"></span>
<a name="l00311"></a>00311 <span class="comment"></span>
<a name="l00312"></a>00312 <span class="comment">\section sec_item Model items</span>
<a name="l00313"></a>00313 <span class="comment">DDHC::MdlItem provides a base class for all items that are part of the</span>
<a name="l00314"></a>00314 <span class="comment">tree presented by DDHC::Model. Beside the usual management functions</span>
<a name="l00315"></a>00315 <span class="comment">for chain manipulation, the class requests it&#39;s inheritants to implement</span>
<a name="l00316"></a>00316 <span class="comment">DDHC::MdlItem::data() function. The implementation needs to examine the column</span>
<a name="l00317"></a>00317 <span class="comment">that is requested and to properly return a value (that may be QVariant()</span>
<a name="l00318"></a>00318 <span class="comment">if nothing is to be returned).</span>
<a name="l00319"></a>00319 <span class="comment"></span>
<a name="l00320"></a>00320 <span class="comment"></span>
<a name="l00321"></a>00321 <span class="comment">\subsection ssec_classes Classes item</span>
<a name="l00322"></a>00322 <span class="comment">One instance of DDHC::Classes is embedded inside the DDHC::Model class. Its</span>
<a name="l00323"></a>00323 <span class="comment">purpose is to manage a list of all classes that were ever added to DDHC.</span>
<a name="l00324"></a>00324 <span class="comment">The class is the parent of all DDHC::AClass instances. The model forwards</span>
<a name="l00325"></a>00325 <span class="comment">requests to add instances to chain using DDHC::Classes::registerClass() function</span>
<a name="l00326"></a>00326 <span class="comment">that looks up that class name. If it finds one it will append the instance there</span>
<a name="l00327"></a>00327 <span class="comment">and if it doesn&#39;t will create a new DDHC::AClass to host that instance.</span>
<a name="l00328"></a>00328 <span class="comment"></span>
<a name="l00329"></a>00329 <span class="comment">DDHC::AClass represents a class that was defined in code. It is always</span>
<a name="l00330"></a>00330 <span class="comment">parented inside a DDHC::Classes instance and it&#39;s purpose is to show</span>
<a name="l00331"></a>00331 <span class="comment">the class name in the list of classes. Instances are rooted inside this one.</span>
<a name="l00332"></a>00332 <span class="comment"></span>
<a name="l00333"></a>00333 <span class="comment"></span>
<a name="l00334"></a>00334 <span class="comment">\subsection ssec_tree Tree item</span>
<a name="l00335"></a>00335 <span class="comment">At the same level as DDHC::Classes and also embedded inside the DDHC::Model</span>
<a name="l00336"></a>00336 <span class="comment">class is DDHC::Tree. It provides a parent for top level DDHC::CInst instances</span>
<a name="l00337"></a>00337 <span class="comment">and presents a hierarchical view of the class instances. The model forwards</span>
<a name="l00338"></a>00338 <span class="comment">requests to append top level instances to DDHC::Tree::append with a pointer</span>
<a name="l00339"></a>00339 <span class="comment">to a DDHC::Ghost class.</span>
<a name="l00340"></a>00340 <span class="comment"></span>
<a name="l00341"></a>00341 <span class="comment"></span>
<a name="l00342"></a>00342 <span class="comment">\subsection ssec_comp Leaf components</span>
<a name="l00343"></a>00343 <span class="comment">DDHC::CInst is a container for class instances that inherit from DDHC:Ghost. It</span>
<a name="l00344"></a>00344 <span class="comment">is always parented inside:</span>
<a name="l00345"></a>00345 <span class="comment">- another DDHC::CInst</span>
<a name="l00346"></a>00346 <span class="comment">- a DDHC::AClass</span>
<a name="l00347"></a>00347 <span class="comment">- (if top level) in DDHC::Tree.</span>
<a name="l00348"></a>00348 <span class="comment"></span>
<a name="l00349"></a>00349 <span class="comment">DDHC::CInst may contain, along with child DDHC::CInst instances, DDHC::VarInst</span>
<a name="l00350"></a>00350 <span class="comment">representing the data that DDHC:Ghost inheriting class has inside. This</span>
<a name="l00351"></a>00351 <span class="comment">provides the developer with a view directly at the data that makes a class.</span>
<a name="l00352"></a>00352 <span class="comment"></span>
<a name="l00353"></a>00353 <span class="comment"></span>
<a name="l00354"></a>00354 <span class="comment">\section sec_ghost The Ghost</span>
<a name="l00355"></a>00355 <span class="comment">This class is the one inherited by classes that are monitored. It is an abstract</span>
<a name="l00356"></a>00356 <span class="comment">class in that it contains a number of purelly virtual methods that make the</span>
<a name="l00357"></a>00357 <span class="comment">instantiation of this class by it&#39;s own impossible.</span>
<a name="l00358"></a>00358 <span class="comment"></span>
<a name="l00359"></a>00359 <span class="comment">DDHC::Ghost::_ddhc_init() is called from inside the inheriting class to initialise the</span>
<a name="l00360"></a>00360 <span class="comment">instance. The function is part of the DDHC_CONSTRUCT macro. It inserts the</span>
<a name="l00361"></a>00361 <span class="comment">instance in it&#39;s class chain and in the tree as top node. The parent may</span>
<a name="l00362"></a>00362 <span class="comment">choose to move to a more proper location later using the DDHC_NODE macro.</span>
<a name="l00363"></a>00363 <span class="comment"></span>
<a name="l00364"></a>00364 <span class="comment">The inheriting class needs to implement DDHC::Ghost::_ddhc_Name() to tell the name of the</span>
<a name="l00365"></a>00365 <span class="comment">class (stored by the DDHC_CONTENT as a static memeber). DDHC::Ghost::_ddhc_Assoc() and</span>
<a name="l00366"></a>00366 <span class="comment">DDHC::Ghost::_ddhc_SetAssoc() are used to get / save the pointer to the tree instance</span>
<a name="l00367"></a>00367 <span class="comment">(CInst inside the hierarchical tree) that hosts this ghost.</span>
<a name="l00368"></a>00368 <span class="comment"></span>
<a name="l00369"></a>00369 <span class="comment">DDHC::Ghost::_ddhc_appendVar() adds an internal variable to this class representation</span>
<a name="l00370"></a>00370 <span class="comment">and DDHC::Ghost::_ddhc_appendClass() reparents a class (that also inherits from Ghost class)</span>
<a name="l00371"></a>00371 <span class="comment">to this class.</span>
<a name="l00372"></a>00372 <span class="comment"></span>
<a name="l00373"></a>00373 <span class="comment"></span>
<a name="l00374"></a>00374 <span class="comment">\page debug_todo    Things to be implemen</span>
<a name="l00375"></a>00375 <span class="comment"></span>
<a name="l00376"></a>00376 <span class="comment"></span>
<a name="l00377"></a>00377 <span class="comment">*/</span>
<a name="l00378"></a>00378 <span class="comment">/* ------------------------------------------------------------------------- */</span>
<a name="l00379"></a>00379 <span class="comment">/* ========================================================================= */</span>
<a name="l00380"></a>00380 <span class="preprocessor">#ifndef __DDHC_INC__</span>
<a name="l00381"></a>00381 <span class="preprocessor"></span><span class="preprocessor">#define __DDHC_INC__</span>
<a name="l00382"></a>00382 <span class="preprocessor"></span><span class="comment">//</span>
<a name="l00383"></a>00383 <span class="comment">//</span>
<a name="l00384"></a>00384 <span class="comment">//</span>
<a name="l00385"></a>00385 <span class="comment">//</span>
<a name="l00386"></a>00386 <span class="comment">/*  INCLUDES    ------------------------------------------------------------ */</span>
<a name="l00387"></a>00387 
<a name="l00388"></a>00388 
<a name="l00389"></a>00389 <span class="comment">/*  INCLUDES    ============================================================ */</span>
<a name="l00390"></a>00390 <span class="comment">//</span>
<a name="l00391"></a>00391 <span class="comment">//</span>
<a name="l00392"></a>00392 <span class="comment">//</span>
<a name="l00393"></a>00393 <span class="comment">//</span>
<a name="l00394"></a>00394 <span class="comment">/*  DEFINITIONS    --------------------------------------------------------- */</span>
<a name="l00395"></a>00395 
<a name="l00396"></a>00396 
<a name="l00397"></a>00397 <span class="comment">/* things that are enabled only if dynamic debugger helper code is enabled */</span>
<a name="l00398"></a>00398 <span class="comment">/* HHHHHHHHHHHHHHH */</span>
<a name="l00399"></a>00399 <span class="preprocessor">#if     (ENABLE_DDHC == 1)</span>
<a name="l00400"></a>00400 <span class="preprocessor"></span>
<a name="l00401"></a>00401 <span class="comment"></span>
<a name="l00402"></a>00402 <span class="comment">/** set associated tree view; the model will manage some visual effect, if set */</span>
<a name="l00403"></a><a class="code" href="ddhc__main_8h.html#a665d86b3c9cc3ce559ed7a8c1eb961f3">00403</a> <span class="preprocessor">#define DDHC_SET_TREE_VIEW(t)           DDHC::Model::setMTree(t)</span>
<a name="l00404"></a>00404 <span class="preprocessor"></span>
<a name="l00405"></a>00405 <span class="comment"></span>
<a name="l00406"></a>00406 <span class="comment">/** to be used to inherit the QObject class only when needed */</span>
<a name="l00407"></a><a class="code" href="ddhc__main_8h.html#a11c872f3f4013282773f6329628a4989">00407</a> <span class="preprocessor">#define DDHC_INHERIT                , public DDHC::Ghost</span>
<a name="l00408"></a>00408 <span class="preprocessor"></span>
<a name="l00409"></a>00409 <span class="comment"></span>
<a name="l00410"></a>00410 <span class="comment">/** to be used to inherit the QObject class only when needed */</span>
<a name="l00411"></a><a class="code" href="ddhc__main_8h.html#a32bc914442a11f7b608e14e2ce66e7a4">00411</a> <span class="preprocessor">#define DDHC_INHERIT_SINGLE         public DDHC::Ghost</span>
<a name="l00412"></a>00412 <span class="preprocessor"></span>
<a name="l00413"></a>00413 <span class="comment"></span>
<a name="l00414"></a>00414 <span class="comment">/** DDHC_CLASS macro is intended to be used inside any class that needs to be</span>
<a name="l00415"></a>00415 <span class="comment">  exposed using this mechanism; it must be placed right at the beginning of</span>
<a name="l00416"></a>00416 <span class="comment">  the definition area.</span>
<a name="l00417"></a>00417 <span class="comment">  */</span>
<a name="l00418"></a><a class="code" href="ddhc__main_8h.html#a93273add2edbf58828a7c139577170ec">00418</a> <span class="preprocessor">#define DDHC_CLASS      \</span>
<a name="l00419"></a>00419 <span class="preprocessor">    public: \</span>
<a name="l00420"></a>00420 <span class="preprocessor">    static QString  _ddhcval_name; \</span>
<a name="l00421"></a>00421 <span class="preprocessor">    DDHC::CInst *   _ddhcval_assoc_c; \</span>
<a name="l00422"></a>00422 <span class="preprocessor">    DDHC::CInst *   _ddhcval_assoc_t; \</span>
<a name="l00423"></a>00423 <span class="preprocessor">    </span><span class="comment">/*      */</span>  \
<a name="l00424"></a>00424     QString         _ddhc_Name          ( void ) { return _ddhcval_name; } \
<a name="l00425"></a>00425     DDHC::CInst *   _ddhc_AssocT        ( void ) { return _ddhcval_assoc_t; } \
<a name="l00426"></a>00426     void            _ddhc_SetAssocT     ( DDHC::CInst * asc_i ) { _ddhcval_assoc_t = asc_i; } \
<a name="l00427"></a>00427     DDHC::CInst *   _ddhc_AssocC        ( void ) { return _ddhcval_assoc_c; } \
<a name="l00428"></a>00428     void            _ddhc_SetAssocC     ( DDHC::CInst * asc_i ) { _ddhcval_assoc_c = asc_i; } \
<a name="l00429"></a>00429     private:
<a name="l00430"></a>00430 
<a name="l00431"></a>00431 
<a name="l00432"></a>00432 
<a name="l00433"></a>00433 <span class="comment"></span>
<a name="l00434"></a>00434 <span class="comment">/** since &quot;the results of calling (directly or indirectly) a pure</span>
<a name="l00435"></a>00435 <span class="comment">virtual function from its constructor are undefined&quot; */</span>
<a name="l00436"></a><a class="code" href="ddhc__main_8h.html#a5450dfe3c644f059533fb6b0a704d9bf">00436</a> <span class="preprocessor">#define DDHC_CONSTRUCT              \</span>
<a name="l00437"></a>00437 <span class="preprocessor">    _ddhc_init();</span>
<a name="l00438"></a>00438 <span class="preprocessor"></span>
<a name="l00439"></a>00439 <span class="comment"></span>
<a name="l00440"></a>00440 <span class="comment">/** since &quot;the results of calling (directly or indirectly) a pure</span>
<a name="l00441"></a>00441 <span class="comment">virtual function from its destructor are undefined&quot; */</span>
<a name="l00442"></a><a class="code" href="ddhc__main_8h.html#a83b4d50889e49e105c89d71acff6f975">00442</a> <span class="preprocessor">#define DDHC_DESTRUCT               \</span>
<a name="l00443"></a>00443 <span class="preprocessor">    _ddhc_end();</span>
<a name="l00444"></a>00444 <span class="preprocessor"></span>
<a name="l00445"></a>00445 <span class="comment"></span>
<a name="l00446"></a>00446 <span class="comment">/** to be used inside source file of the class to generate members */</span>
<a name="l00447"></a><a class="code" href="ddhc__main_8h.html#abeddf5a2c22a7727d1c96c148d05d9cf">00447</a> <span class="preprocessor">#define DDHC_CONTENT(cl_name)       \</span>
<a name="l00448"></a>00448 <span class="preprocessor">    QString cl_name::_ddhcval_name = QString(#cl_name);</span>
<a name="l00449"></a>00449 <span class="preprocessor"></span>
<a name="l00450"></a>00450 
<a name="l00451"></a>00451 <span class="comment"></span>
<a name="l00452"></a>00452 <span class="comment">/** defining variables */</span>
<a name="l00453"></a><a class="code" href="ddhc__main_8h.html#abe1f2d96d3d620116d512432989392b3">00453</a> <span class="preprocessor">#define DDHC_VARIABLE(var_name)     \</span>
<a name="l00454"></a>00454 <span class="preprocessor">    _ddhc_appendVar(QString(#var_name), &amp;var_name);</span>
<a name="l00455"></a>00455 <span class="preprocessor"></span>
<a name="l00456"></a>00456 
<a name="l00457"></a>00457 <span class="comment"></span>
<a name="l00458"></a>00458 <span class="comment">/** defining child classes */</span>
<a name="l00459"></a><a class="code" href="ddhc__main_8h.html#aa520aae0ac8ff4633ace4be388871393">00459</a> <span class="preprocessor">#define DDHC_NODE(var_name)     \</span>
<a name="l00460"></a>00460 <span class="preprocessor">    _ddhc_appendClass(QString s_name, void * address);</span>
<a name="l00461"></a>00461 <span class="preprocessor"></span>
<a name="l00462"></a>00462 
<a name="l00463"></a>00463 <span class="comment"></span>
<a name="l00464"></a>00464 <span class="comment">/** reparent an item to another that is also debugged */</span>
<a name="l00465"></a><a class="code" href="ddhc__main_8h.html#a86ac382665d71d5977e4620723ae78f5">00465</a> <span class="preprocessor">#define DDHC_REPARENT(new_papa)     \</span>
<a name="l00466"></a>00466 <span class="preprocessor">    _ddhc_Reparent(new_papa);</span>
<a name="l00467"></a>00467 <span class="preprocessor"></span>
<a name="l00468"></a>00468 
<a name="l00469"></a>00469 
<a name="l00470"></a>00470 
<a name="l00471"></a>00471 <span class="comment">/*  DEFINITIONS    ========================================================= */</span>
<a name="l00472"></a>00472 <span class="comment">//</span>
<a name="l00473"></a>00473 <span class="comment">//</span>
<a name="l00474"></a>00474 <span class="comment">//</span>
<a name="l00475"></a>00475 <span class="comment">//</span>
<a name="l00476"></a>00476 <span class="comment">/*  DATA    ---------------------------------------------------------------- */</span>
<a name="l00477"></a>00477 
<a name="l00478"></a>00478 
<a name="l00479"></a>00479 
<a name="l00480"></a>00480 <span class="comment">/*  DATA    ================================================================ */</span>
<a name="l00481"></a>00481 <span class="comment">//</span>
<a name="l00482"></a>00482 <span class="comment">//</span>
<a name="l00483"></a>00483 <span class="comment">//</span>
<a name="l00484"></a>00484 <span class="comment">//</span>
<a name="l00485"></a>00485 <span class="comment">/*  FUNCTIONS    ----------------------------------------------------------- */</span>
<a name="l00486"></a>00486 
<a name="l00487"></a>00487 
<a name="l00488"></a>00488 <span class="comment">/*  FUNCTIONS    =========================================================== */</span>
<a name="l00489"></a>00489 <span class="comment">//</span>
<a name="l00490"></a>00490 <span class="comment">//</span>
<a name="l00491"></a>00491 <span class="comment">//</span>
<a name="l00492"></a>00492 <span class="comment">//</span>
<a name="l00493"></a>00493 
<a name="l00494"></a>00494 <span class="preprocessor">#include    &quot;<a class="code" href="model__ddhc_8h.html" title="Contains the definition for DDHCModel class.">model_ddhc.h</a>&quot;</span>
<a name="l00495"></a>00495 <span class="preprocessor">#include    &quot;<a class="code" href="item__ddhc_8h.html" title="Contains the definition for MdlItem class.">item_ddhc.h</a>&quot;</span>
<a name="l00496"></a>00496 <span class="preprocessor">#include    &quot;<a class="code" href="ghost__ddhc_8h.html" title="Contains the definition for Ghost class.">ghost_ddhc.h</a>&quot;</span>
<a name="l00497"></a>00497 <span class="preprocessor">#include    &quot;<a class="code" href="classes__ddhc_8h.html" title="Contains the definition for Classes class.">classes_ddhc.h</a>&quot;</span>
<a name="l00498"></a>00498 <span class="preprocessor">#include    &quot;<a class="code" href="tree__ddhc_8h.html" title="Contains the definition for Tree class.">tree_ddhc.h</a>&quot;</span>
<a name="l00499"></a>00499 <span class="preprocessor">#include    &quot;<a class="code" href="aclass__ddhc_8h.html" title="Contains the definition for AClass class.">aclass_ddhc.h</a>&quot;</span>
<a name="l00500"></a>00500 <span class="preprocessor">#include    &quot;<a class="code" href="tree__ddhc_8h.html" title="Contains the definition for Tree class.">tree_ddhc.h</a>&quot;</span>
<a name="l00501"></a>00501 <span class="preprocessor">#include    &quot;<a class="code" href="tclassi__ddhc_8h.html" title="Contains the definition for CInst class.">tclassi_ddhc.h</a>&quot;</span>
<a name="l00502"></a>00502 <span class="preprocessor">#include    &quot;<a class="code" href="tvari__ddhc_8h.html" title="Contains the definition for VarInst class.">tvari_ddhc.h</a>&quot;</span>
<a name="l00503"></a>00503 
<a name="l00504"></a>00504 
<a name="l00505"></a>00505 <span class="preprocessor">#else</span>
<a name="l00506"></a>00506 <span class="preprocessor"></span><span class="preprocessor">#define DDHC_CLASS</span>
<a name="l00507"></a>00507 <span class="preprocessor"></span><span class="preprocessor">#define DDHC_INHERIT</span>
<a name="l00508"></a>00508 <span class="preprocessor"></span><span class="preprocessor">#define DDHC_INHERIT_SINGLE</span>
<a name="l00509"></a>00509 <span class="preprocessor"></span><span class="preprocessor">#define DDHC_CONSTRUCT</span>
<a name="l00510"></a>00510 <span class="preprocessor"></span><span class="preprocessor">#define DDHC_CONTENT(cl_name)</span>
<a name="l00511"></a>00511 <span class="preprocessor"></span><span class="preprocessor">#define DDHC_VARIABLE(var_name)</span>
<a name="l00512"></a>00512 <span class="preprocessor"></span><span class="preprocessor">#define DDHC_NODE(var_name)</span>
<a name="l00513"></a>00513 <span class="preprocessor"></span><span class="preprocessor">#define DDHC_REPARENT(new_papa)</span>
<a name="l00514"></a>00514 <span class="preprocessor"></span><span class="preprocessor">#define DDHC_DESTRUCT</span>
<a name="l00515"></a>00515 <span class="preprocessor"></span><span class="preprocessor">#endif  //  ENABLE_DDHC</span>
<a name="l00516"></a>00516 <span class="preprocessor"></span><span class="preprocessor">#endif // __DDHC_INC__</span>
<a name="l00517"></a>00517 <span class="preprocessor"></span><span class="comment">/* ------------------------------------------------------------------------- */</span>
<a name="l00518"></a>00518 <span class="comment">/* ========================================================================= */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="ddhc__main_8h.html">ddhc_main.h</a>      </li>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Defines</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

    <li class="footer">Generated on Sun Oct 23 2011 22:06:47 for EquTemper by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
   </ul>
 </div>
</body>
</html>
